vcFlow

vcFlow is a base class for behaviors that support the transfer of components and material flow using connectors/ports.

See in: Overview

Children: vcComponentFlowProxy, vcContainer, vcProductCreator

Referenced by: vcComponent.Container, vcSimFlowField.Container

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
CapacityAvailable	Boolean	RW	Gets or sets a value indicating if flow object will accept an incoming component. See more This is not the same as a logical capacity test since flow type behaviors do not to store components.
Connectors	List[vcBehaviors.vcConnector]	R	Gets a list of connectors in flow object.
Statistics	vcStatistics	RW	Gets or sets a statistics behavior that collects data generated by this flow during a simulation.

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
checkCapacity	Boolean	vcComponent component, Integer index	Tests if the flow object has the capacity to store a given vcComponent that passes through a connector at a given index. See more Generally, this method is used to test the arrival of components at different connectors in order to route components effectively and avoid bottlenecks. The test passes if CapacityAvailable property is set to True. In cases where the flow object has physical capacity to store components, the test depends on the container's ComponentCount and Capacity properties as well as the capacity test used by a connector. See vcConnector for more information. Parameters: component (vcComponent): Component to test with. index (int): Index of the vcConnector. Returns: Boolean: True if has capacity, otherwise false.
setConnection	None	Integer index, vcConnector toConnector	Connects a connector at a given index in the flow object to a given connector. See more Parameters: index (int): Index of the connector. toConnector (vcConnector): Connector to connect, if null fromConnector is disconnected from its connected connectors. Exceptions: RuntimeError: When given index is not within valid range.